<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaBatch: GNOME Data Access 5 manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GNOME Data Access 5 manual">
<link rel="up" href="connection.html" title="Connections &amp; commands">
<link rel="prev" href="libgda-5.0-GdaRepetitiveStatement.html" title="GdaRepetitiveStatement">
<link rel="next" href="GdaHolder.html" title="GdaHolder">
<meta name="generator" content="GTK-Doc V1.32 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#GdaBatch.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#GdaBatch.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#GdaBatch.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="connection.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libgda-5.0-GdaRepetitiveStatement.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GdaHolder.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GdaBatch"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdaBatch.top_of_page"></a>GdaBatch</span></h2>
<p>GdaBatch — Multiple SQL statements grouped together.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GdaBatch.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Stable"><span class="acronym">Stable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="GdaBatch.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GdaBatch.html" title="GdaBatch"><span class="returnvalue">GdaBatch</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdaBatch.html#gda-batch-new" title="gda_batch_new ()">gda_batch_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="GdaBatch.html" title="GdaBatch"><span class="returnvalue">GdaBatch</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdaBatch.html#gda-batch-copy" title="gda_batch_copy ()">gda_batch_copy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GdaBatch.html#gda-batch-add-statement" title="gda_batch_add_statement ()">gda_batch_add_statement</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="GdaBatch.html#gda-batch-remove-statement" title="gda_batch_remove_statement ()">gda_batch_remove_statement</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdaBatch.html#gda-batch-serialize" title="gda_batch_serialize ()">gda_batch_serialize</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
</td>
<td class="function_name">
<a class="link" href="GdaBatch.html#gda-batch-get-statements" title="gda_batch_get_statements ()">gda_batch_get_statements</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="GdaBatch.html#gda-batch-get-parameters" title="gda_batch_get_parameters ()">gda_batch_get_parameters</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaBatch.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signal_proto_type">
<col width="300px" class="signal_proto_name">
<col width="200px" class="signal_proto_flags">
</colgroup>
<tbody><tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="GdaBatch.html#GdaBatch-changed" title="The “changed” signal">changed</a></td>
<td class="signal_flags"><a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaBatch.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GdaBatch.html#GdaBatch-struct" title="GdaBatch">GdaBatch</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GdaBatch.html#GdaBatchError" title="enum GdaBatchError">GdaBatchError</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GdaBatch.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> GdaBatch
</pre>
</div>
<div class="refsect1">
<a name="GdaBatch.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libgda-report/gda-report-engine.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GdaBatch.description"></a><h2>Description</h2>
<p>The <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> object represents one or more SQL statements (as <a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> objects) in a single object.</p>
<p>A <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> can either be built "manually" by assembling together several <a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> objects,
or from an SQL string using a <a class="link" href="GdaSqlParser.html" title="GdaSqlParser"><span class="type">GdaSqlParser</span></a> object.</p>
</div>
<div class="refsect1">
<a name="GdaBatch.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gda-batch-new"></a><h3>gda_batch_new ()</h3>
<pre class="programlisting"><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="returnvalue">GdaBatch</span></a> *
gda_batch_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> object</p>
<div class="refsect3">
<a name="gda-batch-new.returns"></a><h4>Returns</h4>
<p> the new object</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-batch-copy"></a><h3>gda_batch_copy ()</h3>
<pre class="programlisting"><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="returnvalue">GdaBatch</span></a> *
gda_batch_copy (<em class="parameter"><code><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *orig</code></em>);</pre>
<p>Copy constructor</p>
<div class="refsect3">
<a name="gda-batch-copy.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>orig</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> to make a copy of</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-batch-copy.returns"></a><h4>Returns</h4>
<p>a the new copy of <em class="parameter"><code>orig</code></em>
. </p>
<p><span class="annotation">[<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-batch-add-statement"></a><h3>gda_batch_add_statement ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gda_batch_add_statement (<em class="parameter"><code><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *batch</code></em>,
                         <em class="parameter"><code><a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> *stmt</code></em>);</pre>
<p>Add <em class="parameter"><code>stmt</code></em>
 to the list of statements managed by <em class="parameter"><code>batch</code></em>
. A <a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> object can be
added multiple times to a <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> object.</p>
<div class="refsect3">
<a name="gda-batch-add-statement.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>batch</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stmt</p></td>
<td class="parameter_description"><p>a statement to add to <em class="parameter"><code>batch</code></em>
's statements list</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-batch-remove-statement"></a><h3>gda_batch_remove_statement ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gda_batch_remove_statement (<em class="parameter"><code><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *batch</code></em>,
                            <em class="parameter"><code><a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> *stmt</code></em>);</pre>
<p>Removes <em class="parameter"><code>stmt</code></em>
 from the list of statements managed by <em class="parameter"><code>batch</code></em>
. If <em class="parameter"><code>stmt</code></em>
 is present several
times in <em class="parameter"><code>batch</code></em>
's statements' list, then only the first one is removed.</p>
<div class="refsect3">
<a name="gda-batch-remove-statement.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>batch</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>stmt</p></td>
<td class="parameter_description"><p>a statement to remove from <em class="parameter"><code>batch</code></em>
's statements list</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-batch-serialize"></a><h3>gda_batch_serialize ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gda_batch_serialize (<em class="parameter"><code><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *batch</code></em>);</pre>
<p>Creates a string representing the contents of <em class="parameter"><code>batch</code></em>
.</p>
<div class="refsect3">
<a name="gda-batch-serialize.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>batch</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-batch-serialize.returns"></a><h4>Returns</h4>
<p> a string containing the serialized version of <em class="parameter"><code>batch</code></em>
</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-batch-get-statements"></a><h3>gda_batch_get_statements ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="returnvalue">GSList</span></a> *
gda_batch_get_statements (<em class="parameter"><code><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *batch</code></em>);</pre>
<p>Get a list of the <a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> objects contained in <em class="parameter"><code>batch</code></em>
</p>
<div class="refsect3">
<a name="gda-batch-get-statements.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>batch</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-batch-get-statements.returns"></a><h4>Returns</h4>
<p>a list of <a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> which should not be modified. </p>
<p><span class="annotation">[<a href="http://foldoc.org/element-type"><span class="acronym">element-type</span></a> GdaStatement][<a href="http://foldoc.org/transfer%20none"><span class="acronym">transfer none</span></a>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="gda-batch-get-parameters"></a><h3>gda_batch_get_parameters ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
gda_batch_get_parameters (<em class="parameter"><code><a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *batch</code></em>,
                          <em class="parameter"><code><a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> **out_params</code></em>,
                          <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Get a new <a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> object which groups all the execution parameters
which <em class="parameter"><code>batch</code></em>
 needs for all the statements it includes.
This new object is returned though <em class="parameter"><code>out_params</code></em>
.</p>
<p>Note that if <em class="parameter"><code>batch</code></em>
 does not need any parameter, then <em class="parameter"><code>out_params</code></em>
 is set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p>
<div class="refsect3">
<a name="gda-batch-get-parameters.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>batch</p></td>
<td class="parameter_description"><p>a <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_params</p></td>
<td class="parameter_description"><p>a place to store a new <a class="link" href="GdaSet.html" title="GdaSet"><span class="type">GdaSet</span></a> object, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<a href="http://foldoc.org/out"><span class="acronym">out</span></a>][<a href="http://foldoc.org/transfer%20full"><span class="acronym">transfer full</span></a>][<a href="http://foldoc.org/allow-none"><span class="acronym">allow-none</span></a>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a place to store errors, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gda-batch-get-parameters.returns"></a><h4>Returns</h4>
<p> TRUE if no error occurred.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GdaBatch.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GdaBatch-struct"></a><h3>GdaBatch</h3>
<pre class="programlisting">typedef struct _GdaBatch GdaBatch;</pre>
</div>
<hr>
<div class="refsect2">
<a name="GdaBatchError"></a><h3>enum GdaBatchError</h3>
<div class="refsect3">
<a name="GdaBatchError.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody><tr>
<td class="enum_member_name"><p><a name="GDA-BATCH-CONFLICTING-PARAMETER-ERROR:CAPS"></a>GDA_BATCH_CONFLICTING_PARAMETER_ERROR</p></td>
<td> </td>
<td> </td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GdaBatch.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GdaBatch-changed"></a><h3>The <code class="literal">“changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> *batch,
               <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a>  *changed_stmt,
               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>  user_data)</pre>
<p>Gets emitted whenever a <a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a> in the <em class="parameter"><code>batch</code></em>
 object changes</p>
<div class="refsect3">
<a name="GdaBatch-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>batch</p></td>
<td class="parameter_description"><p>the <a class="link" href="GdaBatch.html" title="GdaBatch"><span class="type">GdaBatch</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>changed_stmt</p></td>
<td class="parameter_description"><p>the statement which has been changed</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p>
</div>
</div>
<div class="refsect1">
<a name="GdaBatch.see-also"></a><h2>See Also</h2>
<p><a class="link" href="GdaStatement.html" title="GdaStatement"><span class="type">GdaStatement</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.32</div>
</body>
</html>